Skip to content

An installed app shares the home folder's providers, and a release carries the installers' files - #3

Merged
jeffreyaven merged 3 commits into
mainfrom
installed-data-folder
Nov 20, 2026
Merged

jeffreyaven merged 3 commits into
mainfrom
installed-data-folder

Conversation

@jeffreyaven

Copy link
Copy Markdown
Member

Two changes for shipping the Workbench in the StackQL installers: where an installed app keeps the engine's providers, and how a build that ships is released.

An installed app uses .stackql in the home folder

The MSI installs for the whole machine under Program Files, where an ordinary account cannot write, and a macOS app is a signed bundle. An installed app used to keep the engine's provider cache in a folder of its own under the app data directory. That was apart from the one the stackql command uses, so a provider pulled in one was not there in the other, and on Windows it was in the roaming profile.

  • An installed app now uses .stackql in the home folder, the one the stackql command uses when it is started there, as the command shell the MSI installs does. It writes nothing to the folder it was installed in.
  • An app counts as installed when the engine sits beside its executable, which is how the MSI lays them out, or when it runs from a macOS bundle.
  • A build from this repository still keeps .stackql beside its executable, apart from the operator's providers.
  • The last resort, when the folder cannot be written to, moves to the local app data directory. It is a cache that can be pulled again.

A release carries the files the installers take

Publishing a release from the tag v<version> runs the new Release workflow. It builds three files from the commit the tag names and attaches them, each with a .sha256 beside it.

Release asset For
stackql-workbench_windows_amd64.exe The x64 MSI
stackql-workbench_windows_arm64.exe The arm64 MSI
stackql-workbench_darwin_multiarch.app.tar.gz The PKG

The build scripts of the two installers can fetch the newest release's files from https://github.com/stackql/stackql-workbench/releases/latest/download/<name>.

  • The builds that were in ci.yml are now build.yml, a workflow that is called. CI calls it on every run and the release calls it for the tag, so a release ships what every commit builds and checks.
  • Its last job puts the three files under their release names and keeps them as the artifact stackql-workbench-release-assets. The release attaches exactly those files.
  • scripts/check-release-tag.js stops a release whose tag is not the version the app carries.
  • A file already on a release is not replaced. The workflow can be started by hand with a tag.

What has been run

  • Lint, type check and the 462 webview tests. cargo fmt, clippy and the host tests: 280 unit, 10 agent integration and 14 engine integration, one of them new, which runs a real engine on a folder that stands in for the home folder.
  • On Windows 11, the app with an engine beside it in a folder the account could not write to: the engine was started on .stackql in the home folder, the app listed the providers already there, and nothing was added to the folder of the app.
  • The app alone in a folder it could write to, which is what a build is: it kept a .stackql folder beside itself and listed no providers.
  • The release tag check, with the right tag and two wrong ones.

Not run: the step that attaches files to a release, since no release has been made. The real Program Files, which needs an administrator. The fallback to the local app data directory and the macOS rule have run only in tests.

Generated with Claude Code

jeffreyaven and others added 3 commits November 20, 2026 17:09
The MSI installs for the whole machine under Program Files, where an
ordinary account cannot write, and a macOS app is a signed bundle. An
installed app therefore kept the engine's provider cache in a folder of
its own under the app data directory, apart from the one the stackql
command uses, so a provider pulled in one was not there in the other.

The maintainer decided on 20 November 2026 that an installed app shares
`.stackql` in the home folder with the stackql command. The installers
put the two down together, and the command shell the MSI installs starts
the command in the home folder.

- An app counts as installed when the engine sits beside its executable,
  which is how the MSI lays them out, or when it runs from a macOS
  bundle. It then uses `.stackql` in the home folder and writes nothing
  where it was installed.
- A build from this repository still keeps `.stackql` beside its
  executable, apart from the operator's providers.
- The last resort moves from the app data directory to the local one. It
  is a cache that can be pulled again, and on Windows the app data
  directory follows a user from machine to machine.
- The app's log says where the data folder came from.

What was run on Windows: the app with an engine beside it, in a folder
the account could not write to, started the engine on the home folder
and listed the providers already there, and added nothing to its own
folder. The app alone in a folder it could write to kept a folder beside
itself and listed no providers.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The maintainer asked on 20 November 2026 for a release workflow: when a
release is published from a tag, the two Windows executables and the Mac
app are attached to it, and the installers fetch the newest release.

- `build.yml` holds the builds that were in `ci.yml`, as a workflow that
  is called. CI calls it on every run and the release calls it for the
  tag, so a release ships what every commit builds and checks.
- Its last job puts the three files under the names a release gives
  them, each with a SHA-256 beside it, and keeps them as one artifact.
  The names follow the StackQL release: amd64 and arm64 for Windows,
  multiarch for the Mac. The release attaches exactly those files, so
  the only step no CI run covers is the upload itself.
- `scripts/check-release-tag.js` stops a release whose tag is not the
  version the app carries, or whose three version numbers disagree.
- A file already on a release is not replaced. The workflow can be
  started by hand with a tag, to attach the files after a run that did
  not finish.

`actions/download-artifact` is new here. It is the counterpart of the
`upload-artifact` action the builds already use, and is how one job
takes what another built.

No release has been made, so the upload has not run.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
`README.md` and `CLAUDE.md` for the two changes before this one: where
an installed app keeps the engine's providers, and how a build that
ships is released. Three open questions are closed by them and come off
the list.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@jeffreyaven jeffreyaven self-assigned this Nov 20, 2026
@jeffreyaven
jeffreyaven merged commit 8251a62 into main Nov 20, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant